<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArArgumentParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArArgumentParser.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="classArArgumentParser-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArArgumentParser Class Reference<div class="ingroups"><a class="el" href="group__ImportantClasses.html">Important Classes</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Parse and store program command-line arguments for use by other ARIA classes.  
 <a href="classArArgumentParser.html#details">More...</a></p>

<p><code>#include &lt;ArArgumentParser.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a10192496ef5473e47b93123cf7c4fc7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10192496ef5473e47b93123cf7c4fc7a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a10192496ef5473e47b93123cf7c4fc7a">addDefaultArgument</a> (const char *argument, int position=-1)</td></tr>
<tr class="memdesc:a10192496ef5473e47b93123cf7c4fc7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a string as a default argument. <br /></td></tr>
<tr class="separator:a10192496ef5473e47b93123cf7c4fc7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa338f7162b9429445df6b5f3cb457769"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa338f7162b9429445df6b5f3cb457769"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#aa338f7162b9429445df6b5f3cb457769">addDefaultArgumentAsIs</a> (const char *argument, int position=-1)</td></tr>
<tr class="memdesc:aa338f7162b9429445df6b5f3cb457769"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a string as a default argument as is (without touching spaces or what not) <br /></td></tr>
<tr class="separator:aa338f7162b9429445df6b5f3cb457769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa977bb9b6b998956a39e4a4cc513eaaa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#aa977bb9b6b998956a39e4a4cc513eaaa">ArArgumentParser</a> (int *argc, char **argv)</td></tr>
<tr class="memdesc:aa977bb9b6b998956a39e4a4cc513eaaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, takes the argc argv.  <a href="#aa977bb9b6b998956a39e4a4cc513eaaa">More...</a><br /></td></tr>
<tr class="separator:aa977bb9b6b998956a39e4a4cc513eaaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02244bac60951e47267e7a034ac0caea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a02244bac60951e47267e7a034ac0caea">ArArgumentParser</a> (<a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> *builder)</td></tr>
<tr class="memdesc:a02244bac60951e47267e7a034ac0caea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, takes an argument builder.  <a href="#a02244bac60951e47267e7a034ac0caea">More...</a><br /></td></tr>
<tr class="separator:a02244bac60951e47267e7a034ac0caea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08d0d87154763e4869f0342a47059886"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a08d0d87154763e4869f0342a47059886">checkArgument</a> (const char *argument)</td></tr>
<tr class="memdesc:a08d0d87154763e4869f0342a47059886"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the argument was found.  <a href="#a08d0d87154763e4869f0342a47059886">More...</a><br /></td></tr>
<tr class="separator:a08d0d87154763e4869f0342a47059886"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb2c8381cfd3982b5230ab0e345d48d8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#adb2c8381cfd3982b5230ab0e345d48d8">checkArgumentVar</a> (const char *argument,...)</td></tr>
<tr class="memdesc:adb2c8381cfd3982b5230ab0e345d48d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the argument was found.  <a href="#adb2c8381cfd3982b5230ab0e345d48d8">More...</a><br /></td></tr>
<tr class="separator:adb2c8381cfd3982b5230ab0e345d48d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f49e13ab287d2aaaa571b8dde116d78"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a7f49e13ab287d2aaaa571b8dde116d78">checkHelp</a> ()</td></tr>
<tr class="memdesc:a7f49e13ab287d2aaaa571b8dde116d78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for the help argument.  <a href="#a7f49e13ab287d2aaaa571b8dde116d78">More...</a><br /></td></tr>
<tr class="separator:a7f49e13ab287d2aaaa571b8dde116d78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3889cbdfa862031c51bf80e06954914"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#ac3889cbdfa862031c51bf80e06954914">checkHelpAndWarnUnparsed</a> (unsigned int numArgsOkay=0)</td></tr>
<tr class="memdesc:ac3889cbdfa862031c51bf80e06954914"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for the help strings and warns about unparsed arguments.  <a href="#ac3889cbdfa862031c51bf80e06954914">More...</a><br /></td></tr>
<tr class="separator:ac3889cbdfa862031c51bf80e06954914"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca9661c6e8ef423337590bc5c2336dec"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#aca9661c6e8ef423337590bc5c2336dec">checkParameterArgument</a> (const char *argument, bool returnFirst=false)</td></tr>
<tr class="memdesc:aca9661c6e8ef423337590bc5c2336dec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the word/argument after given argument.  <a href="#aca9661c6e8ef423337590bc5c2336dec">More...</a><br /></td></tr>
<tr class="separator:aca9661c6e8ef423337590bc5c2336dec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19bde315a3456ae1034e4f6f84b46f62"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a19bde315a3456ae1034e4f6f84b46f62">checkParameterArgumentBool</a> (const char *argument, bool *dest, bool *wasReallySet=NULL, bool returnFirst=false)</td></tr>
<tr class="memdesc:a19bde315a3456ae1034e4f6f84b46f62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the word/argument after given argument.  <a href="#a19bde315a3456ae1034e4f6f84b46f62">More...</a><br /></td></tr>
<tr class="separator:a19bde315a3456ae1034e4f6f84b46f62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebf5e0ef3e5f5a86bac1f8f2af1e7829"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#aebf5e0ef3e5f5a86bac1f8f2af1e7829">checkParameterArgumentBoolVar</a> (bool *wasReallySet, bool *dest, const char *argument,...)</td></tr>
<tr class="memdesc:aebf5e0ef3e5f5a86bac1f8f2af1e7829"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the word/argument after given argument.  <a href="#aebf5e0ef3e5f5a86bac1f8f2af1e7829">More...</a><br /></td></tr>
<tr class="separator:aebf5e0ef3e5f5a86bac1f8f2af1e7829"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2d26852c3f2eb5306c4a88c240109f9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#ae2d26852c3f2eb5306c4a88c240109f9">checkParameterArgumentDouble</a> (const char *argument, double *dest, bool *wasReallySet=NULL, bool returnFirst=false)</td></tr>
<tr class="memdesc:ae2d26852c3f2eb5306c4a88c240109f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the floating point number after given argument.  <a href="#ae2d26852c3f2eb5306c4a88c240109f9">More...</a><br /></td></tr>
<tr class="separator:ae2d26852c3f2eb5306c4a88c240109f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a281054a5e44b0c88ae1a192eec502ab9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a281054a5e44b0c88ae1a192eec502ab9">checkParameterArgumentDoubleVar</a> (bool *wasReallySet, double *dest, const char *argument,...)</td></tr>
<tr class="memdesc:a281054a5e44b0c88ae1a192eec502ab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the double after given argument.  <a href="#a281054a5e44b0c88ae1a192eec502ab9">More...</a><br /></td></tr>
<tr class="separator:a281054a5e44b0c88ae1a192eec502ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c93c1494a6aee16434722119b3bd99d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a8c93c1494a6aee16434722119b3bd99d">checkParameterArgumentFloat</a> (const char *argument, float *dest, bool *wasReallySet=NULL, bool returnFirst=false)</td></tr>
<tr class="memdesc:a8c93c1494a6aee16434722119b3bd99d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the floating point number after given argument.  <a href="#a8c93c1494a6aee16434722119b3bd99d">More...</a><br /></td></tr>
<tr class="separator:a8c93c1494a6aee16434722119b3bd99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3a465c37d7d51bd013368fab963745f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#ad3a465c37d7d51bd013368fab963745f">checkParameterArgumentFloatVar</a> (bool *wasReallySet, float *dest, const char *argument,...)</td></tr>
<tr class="memdesc:ad3a465c37d7d51bd013368fab963745f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the float after given argument.  <a href="#ad3a465c37d7d51bd013368fab963745f">More...</a><br /></td></tr>
<tr class="separator:ad3a465c37d7d51bd013368fab963745f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cbddc515e1be6d901b1a0c846f19ef8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a6cbddc515e1be6d901b1a0c846f19ef8">checkParameterArgumentInteger</a> (const char *argument, int *dest, bool *wasReallySet=NULL, bool returnFirst=false)</td></tr>
<tr class="memdesc:a6cbddc515e1be6d901b1a0c846f19ef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the integer after given argument.  <a href="#a6cbddc515e1be6d901b1a0c846f19ef8">More...</a><br /></td></tr>
<tr class="separator:a6cbddc515e1be6d901b1a0c846f19ef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8704f7fd54d22c68256cb36315136a37"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a8704f7fd54d22c68256cb36315136a37">checkParameterArgumentIntegerVar</a> (bool *wasReallySet, int *dest, const char *argument,...)</td></tr>
<tr class="memdesc:a8704f7fd54d22c68256cb36315136a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the integer after given argument.  <a href="#a8704f7fd54d22c68256cb36315136a37">More...</a><br /></td></tr>
<tr class="separator:a8704f7fd54d22c68256cb36315136a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b3a82b02b077f3c86d7a9e62322946f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a7b3a82b02b077f3c86d7a9e62322946f">checkParameterArgumentString</a> (const char *argument, const char **dest, bool *wasReallySet=NULL, bool returnFirst=false)</td></tr>
<tr class="memdesc:a7b3a82b02b077f3c86d7a9e62322946f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the word/argument after given argument.  <a href="#a7b3a82b02b077f3c86d7a9e62322946f">More...</a><br /></td></tr>
<tr class="separator:a7b3a82b02b077f3c86d7a9e62322946f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d1edcc90fa221ac61233b091cbd2c37"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a6d1edcc90fa221ac61233b091cbd2c37">checkParameterArgumentStringVar</a> (bool *wasReallySet, const char **dest, const char *argument,...)</td></tr>
<tr class="memdesc:a6d1edcc90fa221ac61233b091cbd2c37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the word/argument after given argument.  <a href="#a6d1edcc90fa221ac61233b091cbd2c37">More...</a><br /></td></tr>
<tr class="separator:a6d1edcc90fa221ac61233b091cbd2c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88450be1f9acdb05fed7a3df47bdaf69"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a88450be1f9acdb05fed7a3df47bdaf69">checkParameterArgumentVar</a> (const char *argument,...)</td></tr>
<tr class="memdesc:a88450be1f9acdb05fed7a3df47bdaf69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the word/argument after given argument.  <a href="#a88450be1f9acdb05fed7a3df47bdaf69">More...</a><br /></td></tr>
<tr class="separator:a88450be1f9acdb05fed7a3df47bdaf69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47aa47b8a59cdea0142a728db11ccbf9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47aa47b8a59cdea0142a728db11ccbf9"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a47aa47b8a59cdea0142a728db11ccbf9">getArg</a> (size_t whichArg) const </td></tr>
<tr class="memdesc:a47aa47b8a59cdea0142a728db11ccbf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a specific argument. <br /></td></tr>
<tr class="separator:a47aa47b8a59cdea0142a728db11ccbf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3221128461a8f3a84c78ec6e37ce82a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3221128461a8f3a84c78ec6e37ce82a"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#ad3221128461a8f3a84c78ec6e37ce82a">getArgc</a> (void) const </td></tr>
<tr class="memdesc:ad3221128461a8f3a84c78ec6e37ce82a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets how many arguments are left in this parser. <br /></td></tr>
<tr class="separator:ad3221128461a8f3a84c78ec6e37ce82a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21e93fdbbf7f473a606417e855e1067a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21e93fdbbf7f473a606417e855e1067a"></a>
const <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a21e93fdbbf7f473a606417e855e1067a">getArgumentBuilder</a> (void) const </td></tr>
<tr class="memdesc:a21e93fdbbf7f473a606417e855e1067a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the argument builder, if one is being used (may be NULL) <br /></td></tr>
<tr class="separator:a21e93fdbbf7f473a606417e855e1067a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb4699fd41b8ca2365a18f68230dabf5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb4699fd41b8ca2365a18f68230dabf5"></a>
char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#adb4699fd41b8ca2365a18f68230dabf5">getArgv</a> (void) const </td></tr>
<tr class="memdesc:adb4699fd41b8ca2365a18f68230dabf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the argv. <br /></td></tr>
<tr class="separator:adb4699fd41b8ca2365a18f68230dabf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bc40616bdfedbc3b0cd3cd4ca270ed9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bc40616bdfedbc3b0cd3cd4ca270ed9"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a1bc40616bdfedbc3b0cd3cd4ca270ed9">getStartingArguments</a> (void) const </td></tr>
<tr class="memdesc:a1bc40616bdfedbc3b0cd3cd4ca270ed9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the arguments this parser started with (if possible, NULL otherwise) <br /></td></tr>
<tr class="separator:a1bc40616bdfedbc3b0cd3cd4ca270ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6bdff0e8039200dcf4413292639650b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#ae6bdff0e8039200dcf4413292639650b">getWasReallySetOnlyTrue</a> (void)</td></tr>
<tr class="memdesc:ae6bdff0e8039200dcf4413292639650b"><td class="mdescLeft">&#160;</td><td class="mdescRight">If we only set wasReallySet to true.  <a href="#ae6bdff0e8039200dcf4413292639650b">More...</a><br /></td></tr>
<tr class="separator:ae6bdff0e8039200dcf4413292639650b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a501694b62a7f8b0c3cadd84aeafe1b35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a501694b62a7f8b0c3cadd84aeafe1b35">loadDefaultArguments</a> (int positon=1)</td></tr>
<tr class="memdesc:a501694b62a7f8b0c3cadd84aeafe1b35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds args from default files and environmental variables.  <a href="#a501694b62a7f8b0c3cadd84aeafe1b35">More...</a><br /></td></tr>
<tr class="separator:a501694b62a7f8b0c3cadd84aeafe1b35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97aa0dbbb24ff0c278e44ead1606b581"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97aa0dbbb24ff0c278e44ead1606b581"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a97aa0dbbb24ff0c278e44ead1606b581">log</a> (void) const </td></tr>
<tr class="memdesc:a97aa0dbbb24ff0c278e44ead1606b581"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints out the arguments left in this parser. <br /></td></tr>
<tr class="separator:a97aa0dbbb24ff0c278e44ead1606b581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48452e7f122ec469d37bfeabef2928a8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48452e7f122ec469d37bfeabef2928a8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a48452e7f122ec469d37bfeabef2928a8">removeArg</a> (size_t which)</td></tr>
<tr class="memdesc:a48452e7f122ec469d37bfeabef2928a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal function to remove an argument that was parsed. <br /></td></tr>
<tr class="separator:a48452e7f122ec469d37bfeabef2928a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a088077c44dafcd8b1a11deb821155f47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a088077c44dafcd8b1a11deb821155f47">setWasReallySetOnlyTrue</a> (bool wasReallySetOnlyTrue)</td></tr>
<tr class="memdesc:a088077c44dafcd8b1a11deb821155f47"><td class="mdescLeft">&#160;</td><td class="mdescRight">If we should only set wasReallySet to true.  <a href="#a088077c44dafcd8b1a11deb821155f47">More...</a><br /></td></tr>
<tr class="separator:a088077c44dafcd8b1a11deb821155f47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37eeb68abd40fe5eefa15632f2c19381"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37eeb68abd40fe5eefa15632f2c19381"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a37eeb68abd40fe5eefa15632f2c19381">~ArArgumentParser</a> ()</td></tr>
<tr class="memdesc:a37eeb68abd40fe5eefa15632f2c19381"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a37eeb68abd40fe5eefa15632f2c19381"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a334695df6617f4d2137d367b9203c890"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a334695df6617f4d2137d367b9203c890">addDefaultArgumentEnv</a> (const char *env)</td></tr>
<tr class="memdesc:a334695df6617f4d2137d367b9203c890"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds another file or environmental variable to the list of defaults.  <a href="#a334695df6617f4d2137d367b9203c890">More...</a><br /></td></tr>
<tr class="separator:a334695df6617f4d2137d367b9203c890"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3829748cdf17452be8c5fdd8a9638be5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a3829748cdf17452be8c5fdd8a9638be5">addDefaultArgumentFile</a> (const char *file)</td></tr>
<tr class="memdesc:a3829748cdf17452be8c5fdd8a9638be5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds another file or environmental variable to the list of defaults.  <a href="#a3829748cdf17452be8c5fdd8a9638be5">More...</a><br /></td></tr>
<tr class="separator:a3829748cdf17452be8c5fdd8a9638be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a364f0c490c93dd59dfe3ba7f9b384803"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a364f0c490c93dd59dfe3ba7f9b384803"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArArgumentParser.html#a364f0c490c93dd59dfe3ba7f9b384803">logDefaultArgumentLocations</a> (void)</td></tr>
<tr class="memdesc:a364f0c490c93dd59dfe3ba7f9b384803"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logs the default argument locations. <br /></td></tr>
<tr class="separator:a364f0c490c93dd59dfe3ba7f9b384803"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a456467ccc4776ebaa410c7f16dc5e5e6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a456467ccc4776ebaa410c7f16dc5e5e6"></a>
int *&#160;</td><td class="memItemRight" valign="bottom"><b>myArgc</b></td></tr>
<tr class="separator:a456467ccc4776ebaa410c7f16dc5e5e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae98b4017d8691b251151c59445a41993"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae98b4017d8691b251151c59445a41993"></a>
char **&#160;</td><td class="memItemRight" valign="bottom"><b>myArgv</b></td></tr>
<tr class="separator:ae98b4017d8691b251151c59445a41993"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a541219b614bac0022721bb2ea567e423"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a541219b614bac0022721bb2ea567e423"></a>
<a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>myBuilder</b></td></tr>
<tr class="separator:a541219b614bac0022721bb2ea567e423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d078202a05df119d445488d63fd075e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d078202a05df119d445488d63fd075e"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><b>myEmptyArg</b> [1]</td></tr>
<tr class="separator:a6d078202a05df119d445488d63fd075e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9ade4af5fd7a8912d697e6dd925c6d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9ade4af5fd7a8912d697e6dd925c6d4"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myHelp</b></td></tr>
<tr class="separator:ac9ade4af5fd7a8912d697e6dd925c6d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdd97dd7ac7d7e7aa9fa83ec53bf828a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abdd97dd7ac7d7e7aa9fa83ec53bf828a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myOwnBuilder</b></td></tr>
<tr class="separator:abdd97dd7ac7d7e7aa9fa83ec53bf828a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2109ab56ae7a8b487a0b59406775106b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2109ab56ae7a8b487a0b59406775106b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myReallySetOnlyTrue</b></td></tr>
<tr class="separator:a2109ab56ae7a8b487a0b59406775106b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6de33bc546c3d72d0fc06e46cedd9016"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6de33bc546c3d72d0fc06e46cedd9016"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myUsingBuilder</b></td></tr>
<tr class="separator:a6de33bc546c3d72d0fc06e46cedd9016"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a9d07795a391c1d6ac4731aa9120b0a9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d07795a391c1d6ac4731aa9120b0a9b"></a>
static std::list&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>ourDefaultArgumentLocIsFile</b></td></tr>
<tr class="separator:a9d07795a391c1d6ac4731aa9120b0a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a794b6e13350954a1ea5fc91d35b5ed70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a794b6e13350954a1ea5fc91d35b5ed70"></a>
static std::list&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>ourDefaultArgumentLocs</b></td></tr>
<tr class="separator:a794b6e13350954a1ea5fc91d35b5ed70"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parse and store program command-line arguments for use by other ARIA classes. </p>
<p>This class is made for parsing arguments from the argv and argc variables passed into a program's main() function by the operating system, from an <a class="el" href="classArArgumentBuilder.html" title="This class is to build arguments for things that require argc and argv. ">ArArgumentBuilder</a> object, or just from a string (e.g. provided by WinMain() in a Windows MFC program.)</p>
<p>It will also load default argument values if you call <a class="el" href="classArArgumentParser.html#a501694b62a7f8b0c3cadd84aeafe1b35" title="Adds args from default files and environmental variables. ">loadDefaultArguments()</a>. <a class="el" href="classAria.html#ad99c16b5d947229d9f8e1c5b2d4cdd73" title="Initialize Aria global data struture and perform OS-specific initialization, including adding OS sign...">Aria::init()</a> adds the file /etc/Aria.args and the environment variable ARIAARGS as locations for argument defaults, so <a class="el" href="classArArgumentParser.html#a501694b62a7f8b0c3cadd84aeafe1b35" title="Adds args from default files and environmental variables. ">loadDefaultArguments()</a> will always search those. You can use this mechanism to avoid needing to always supply command line parameters to all programs. For example, if you use different serial ports than the defaults for the robot and laser, you can put a -robotPort or -laserPort argument in /etc/Aria.args for all programs that call <a class="el" href="classArArgumentParser.html#a501694b62a7f8b0c3cadd84aeafe1b35" title="Adds args from default files and environmental variables. ">loadDefaultArguments()</a> to use. You can add other files or environment variables to the list of default argument locations with <a class="el" href="classArArgumentParser.html#a3829748cdf17452be8c5fdd8a9638be5" title="Adds another file or environmental variable to the list of defaults. ">addDefaultArgumentFile()</a> and <a class="el" href="classArArgumentParser.html#a334695df6617f4d2137d367b9203c890" title="Adds another file or environmental variable to the list of defaults. ">addDefaultArgumentEnv()</a>.</p>
<p>Note that the wasReallySet behavior has changed. It used to set the variable to false or to true, now it will only set it to false if 'setWasReallySetOnlyTrue' is set to false. By default that is set to false, but you can just set it to true after you make the parser with no ill effects since all of the built in <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> parsers will play nicely with this value, setting it to true or false while they parse but then setting it to whatever it was when they started. This change in behavior is so that checking for two things (like -robotPort and -rp) can work without a lot of extra work. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="actionExample_8cpp-example.html#_a12">actionExample.cpp</a>, <a class="el" href="actionGroupExample_8cpp-example.html#_a3">actionGroupExample.cpp</a>, <a class="el" href="actsColorFollowingExample_8cpp-example.html#_a20">actsColorFollowingExample.cpp</a>, <a class="el" href="auxSerialExample_8cpp-example.html#_a9">auxSerialExample.cpp</a>, <a class="el" href="cameraPTZExample_8cpp-example.html#_a1">cameraPTZExample.cpp</a>, <a class="el" href="configExample_8cpp-example.html#_a13">configExample.cpp</a>, <a class="el" href="customRangeSensorExample_8cpp-example.html#_a21">customRangeSensorExample.cpp</a>, <a class="el" href="customRangeSensorExampleRobotTask_8cpp-example.html#_a24">customRangeSensorExampleRobotTask.cpp</a>, <a class="el" href="dataLoggerExample_8cpp-example.html#_a3">dataLoggerExample.cpp</a>, <a class="el" href="demo_8cpp-example.html#_a7">demo.cpp</a>, <a class="el" href="dpptuExample_8cpp-example.html#_a20">dpptuExample.cpp</a>, <a class="el" href="gotoActionExample_8cpp-example.html#_a1">gotoActionExample.cpp</a>, <a class="el" href="gpsExample_8cpp-example.html#_a1">gpsExample.cpp</a>, <a class="el" href="gpsRobotTaskExample_8cpp-example.html#_a7">gpsRobotTaskExample.cpp</a>, <a class="el" href="gripperExample_8cpp-example.html#_a21">gripperExample.cpp</a>, <a class="el" href="gyroExample_8cpp-example.html#_a22">gyroExample.cpp</a>, <a class="el" href="imuExample_8cpp-example.html#_a1">imuExample.cpp</a>, <a class="el" href="joydriveActionExample_8cpp-example.html#_a11">joydriveActionExample.cpp</a>, <a class="el" href="laserConnect_8cpp-example.html#_a2">laserConnect.cpp</a>, <a class="el" href="lasers_8cpp-example.html#_a2">lasers.cpp</a>, <a class="el" href="lineFinderExample_8cpp-example.html#_a1">lineFinderExample.cpp</a>, <a class="el" href="moduleExample_8cpp-example.html#_a10">moduleExample.cpp</a>, <a class="el" href="mtxAnalogIOExample_8cpp-example.html#_a1">mtxAnalogIOExample.cpp</a>, <a class="el" href="mtxDigitalIOExample_8cpp-example.html#_a1">mtxDigitalIOExample.cpp</a>, <a class="el" href="mtxWheelLights_8cpp-example.html#_a1">mtxWheelLights.cpp</a>, <a class="el" href="robotConnectionCallbacks_8cpp-example.html#_a10">robotConnectionCallbacks.cpp</a>, <a class="el" href="robotSyncTaskExample_8cpp-example.html#_a4">robotSyncTaskExample.cpp</a>, <a class="el" href="seekurPower_8cpp-example.html#_a1">seekurPower.cpp</a>, <a class="el" href="simpleConnect_8cpp-example.html#_a1">simpleConnect.cpp</a>, <a class="el" href="simpleMotionCommands_8cpp-example.html#_a2">simpleMotionCommands.cpp</a>, <a class="el" href="teleopActionsExample_8cpp-example.html#_a1">teleopActionsExample.cpp</a>, <a class="el" href="triangleDriveToActionExample_8cpp-example.html#_a2">triangleDriveToActionExample.cpp</a>, <a class="el" href="twoRobotWander_8cpp-example.html#_a1">twoRobotWander.cpp</a>, and <a class="el" href="wander_8cpp-example.html#_a1">wander.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa977bb9b6b998956a39e4a4cc513eaaa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ArArgumentParser::ArArgumentParser </td>
          <td>(</td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor, takes the argc argv. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argc</td><td>pointer to program argument count (e.g. <em>argc</em> from main()) </td></tr>
    <tr><td class="paramname">argv</td><td>array of program arguments (e.g. <em>arcv</em> from main()) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a02244bac60951e47267e7a034ac0caea"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ArArgumentParser::ArArgumentParser </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> *&#160;</td>
          <td class="paramname"><em>builder</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor, takes an argument builder. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">builder</td><td>an <a class="el" href="classArArgumentBuilder.html" title="This class is to build arguments for things that require argc and argv. ">ArArgumentBuilder</a> object containing arguments </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a334695df6617f4d2137d367b9203c890"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void ArArgumentParser::addDefaultArgumentEnv </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>env</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds another file or environmental variable to the list of defaults. </p>
<p>This adds an environment variable to the list of default argument locations.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">env</td><td>Name of the environment variable </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3829748cdf17452be8c5fdd8a9638be5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void ArArgumentParser::addDefaultArgumentFile </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>file</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds another file or environmental variable to the list of defaults. </p>
<p>This adds a file to the list of default argument locations.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">file</td><td>Name of the file </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a08d0d87154763e4869f0342a47059886"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkArgument </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns true if the argument was found. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">...</td><td>the extra string to feed into the argument for parsing (like printf)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the argument was found, false otherwise </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="configExample_8cpp-example.html#a16">configExample.cpp</a>, <a class="el" href="gpsExample_8cpp-example.html#a15">gpsExample.cpp</a>, and <a class="el" href="seekurPower_8cpp-example.html#a11">seekurPower.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="adb2c8381cfd3982b5230ab0e345d48d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkArgumentVar </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns true if the argument was found. </p>
<p><b>Java and Python Wrappers:</b> Not available in Java or Python wrapper libraries. </p>

</div>
</div>
<a class="anchor" id="a7f49e13ab287d2aaaa571b8dde116d78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkHelp </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks for the help argument. </p>
<p>Check whether a special -help flag was given in the arguments The following are the help flags: -help, -h, &ndash;help, /?, /h.</p>
<dl class="section return"><dt>Returns</dt><dd>false if a help flag was found true otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="ac3889cbdfa862031c51bf80e06954914"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkHelpAndWarnUnparsed </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>numArgsOkay</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks for the help strings and warns about unparsed arguments. </p>
<p>Check whether a special -help flag was given in the arguments.</p>
<p>If a -help flag was not given, also check whether any arguments remain unparsed by this argument parser. The following are the help flags: -help, -h, &ndash;help, /?, /h. </p><dl class="section return"><dt>Returns</dt><dd>false if a help flag was found or unparsed arguments were found, true otherwise. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">numArgsOkay</td><td>If you plan on checking for additional arguments later in the program, you can specify the number of arguments expected here, which prevents this method from warning about them being unparsed yet. </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="actionExample_8cpp-example.html#a17">actionExample.cpp</a>, <a class="el" href="actionGroupExample_8cpp-example.html#a11">actionGroupExample.cpp</a>, <a class="el" href="actsColorFollowingExample_8cpp-example.html#a28">actsColorFollowingExample.cpp</a>, <a class="el" href="auxSerialExample_8cpp-example.html#a15">auxSerialExample.cpp</a>, <a class="el" href="cameraPTZExample_8cpp-example.html#a10">cameraPTZExample.cpp</a>, <a class="el" href="customRangeSensorExample_8cpp-example.html#a26">customRangeSensorExample.cpp</a>, <a class="el" href="customRangeSensorExampleRobotTask_8cpp-example.html#a29">customRangeSensorExampleRobotTask.cpp</a>, <a class="el" href="dataLoggerExample_8cpp-example.html#a17">dataLoggerExample.cpp</a>, <a class="el" href="demo_8cpp-example.html#a15">demo.cpp</a>, <a class="el" href="dpptuExample_8cpp-example.html#a26">dpptuExample.cpp</a>, <a class="el" href="gotoActionExample_8cpp-example.html#a11">gotoActionExample.cpp</a>, <a class="el" href="gpsExample_8cpp-example.html#a10">gpsExample.cpp</a>, <a class="el" href="gpsRobotTaskExample_8cpp-example.html#a15">gpsRobotTaskExample.cpp</a>, <a class="el" href="gripperExample_8cpp-example.html#a26">gripperExample.cpp</a>, <a class="el" href="imuExample_8cpp-example.html#a9">imuExample.cpp</a>, <a class="el" href="joydriveActionExample_8cpp-example.html#a18">joydriveActionExample.cpp</a>, <a class="el" href="laserConnect_8cpp-example.html#a9">laserConnect.cpp</a>, <a class="el" href="lasers_8cpp-example.html#a9">lasers.cpp</a>, <a class="el" href="lineFinderExample_8cpp-example.html#a9">lineFinderExample.cpp</a>, <a class="el" href="moduleExample_8cpp-example.html#a15">moduleExample.cpp</a>, <a class="el" href="mtxAnalogIOExample_8cpp-example.html#a4">mtxAnalogIOExample.cpp</a>, <a class="el" href="mtxDigitalIOExample_8cpp-example.html#a4">mtxDigitalIOExample.cpp</a>, <a class="el" href="mtxWheelLights_8cpp-example.html#a8">mtxWheelLights.cpp</a>, <a class="el" href="robotConnectionCallbacks_8cpp-example.html#a15">robotConnectionCallbacks.cpp</a>, <a class="el" href="robotSyncTaskExample_8cpp-example.html#a10">robotSyncTaskExample.cpp</a>, <a class="el" href="simpleConnect_8cpp-example.html#a8">simpleConnect.cpp</a>, <a class="el" href="simpleMotionCommands_8cpp-example.html#a8">simpleMotionCommands.cpp</a>, <a class="el" href="teleopActionsExample_8cpp-example.html#a8">teleopActionsExample.cpp</a>, <a class="el" href="triangleDriveToActionExample_8cpp-example.html#a9">triangleDriveToActionExample.cpp</a>, <a class="el" href="twoRobotWander_8cpp-example.html#a4">twoRobotWander.cpp</a>, and <a class="el" href="wander_8cpp-example.html#a9">wander.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="aca9661c6e8ef423337590bc5c2336dec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char * ArArgumentParser::checkParameterArgument </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>returnFirst</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the word/argument after given argument. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for. If the argument is found, then it is removed from the argument list</td></tr>
    <tr><td class="paramname">returnFirst</td><td>true if we should just take the first matching argument, or false if we should iterate through the list and only use the last one (default is false, use true if you want to use the same parameter multiple times)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NULL if the argument wasn't found; the value given after the found argument; or at empty string (with a NULL first character) if the argument was found but no value followed the argument flag. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="twoRobotWander_8cpp-example.html#a2">twoRobotWander.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a19bde315a3456ae1034e4f6f84b46f62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentBool </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>returnFirst</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the word/argument after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dest</td><td>if <em>argument</em> is found and is followed by a recognized string representation of a boolean value ("true", "false", "1", or "0"), then <em>dest</em> is set to the appropriate value</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
    <tr><td class="paramname">returnFirst</td><td>if we should go just take the first argument (true) or if we should through the list and pull up the last one (default is false, use true if you want to use the same parameter multiple times)</td></tr>
    <tr><td class="paramname">argument</td><td>the argument string to search for. If the argument is found, it is removed from the list of arguments</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if <em>argument</em> was found but was not followed by a recognized value (an error), or true if <em>argument</em> was not found, or if the argument was there with a valid parameter </dd></dl>

</div>
</div>
<a class="anchor" id="aebf5e0ef3e5f5a86bac1f8f2af1e7829"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentBoolVar </td>
          <td>(</td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the word/argument after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<p><b>Java and Python Wrappers:</b> Not available in Java or Python wrapper libraries.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the boolean value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
    <tr><td class="paramname">dest</td><td>if <em>argument</em> is found and is followed by a recognized string representation of a boolean value ("true", "false", "1", or "0"), then <em>dest</em> is set to the appropriate value</td></tr>
    <tr><td class="paramname">argument</td><td>the argument string to search for. If the argument is found, it is removed from the list of arguments</td></tr>
    <tr><td class="paramname">...</td><td>if <em>argument</em> contains format codes (like printf()), provide the values to substitute following <em>argument</em>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if <em>argument</em> was found but was not followed by a recognized value (an error), or true if <em>argument</em> was not found, or if the argument was there with a valid parameter </dd></dl>

</div>
</div>
<a class="anchor" id="ae2d26852c3f2eb5306c4a88c240109f9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentDouble </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>returnFirst</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the floating point number after given argument. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the argument to check for. if found, it is removed from the list of arguments </td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter given after the argument is found and is a valid double, then the target of this pointer is assigned to the found value. </td></tr>
    <tr><td class="paramname">returnFirst</td><td>true if only the first instance of the argument given should be used, false if only the last (and all preceding instances discarded).</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if the argument was given but an error occurred while parsing the double parameter (i.e. no parameter given, or it was not a parsable double). </dd></dl>

</div>
</div>
<a class="anchor" id="a281054a5e44b0c88ae1a192eec502ab9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentDoubleVar </td>
          <td>(</td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the double after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<p><b>Java and Python Wrappers:</b> Not available in Java or Python wrapper libraries.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter to the argument is found and is a valid integer then dest is set to the integer value</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
    <tr><td class="paramname">...</td><td>the extra string to feed into the argument for parsing (like printf)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if either this argument wasn't there or if the argument was there with a valid parameter </dd></dl>

</div>
</div>
<a class="anchor" id="a8c93c1494a6aee16434722119b3bd99d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentFloat </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>returnFirst</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the floating point number after given argument. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the argument to check for. if found, it is removed from the list of arguments </td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter given after the argument is found and is a valid float, then the target of this pointer is assigned to the found value. </td></tr>
    <tr><td class="paramname">returnFirst</td><td>true if only the first instance of the argument given should be used, false if only the last (and all preceding instances discarded).</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if the argument was given but an error occurred while parsing the float parameter (i.e. no parameter given, or it was not a parsable float). </dd></dl>

</div>
</div>
<a class="anchor" id="ad3a465c37d7d51bd013368fab963745f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentFloatVar </td>
          <td>(</td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the float after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<p><b>Java and Python Wrappers:</b> Not available in Java or Python wrapper libraries.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter to the argument is found and is a valid integer then dest is set to the integer value</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
    <tr><td class="paramname">...</td><td>the extra string to feed into the argument for parsing (like printf)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if either this argument wasn't there or if the argument was there with a valid parameter </dd></dl>

</div>
</div>
<a class="anchor" id="a6cbddc515e1be6d901b1a0c846f19ef8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentInteger </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>returnFirst</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the integer after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter to the argument is found and is a valid integer then dest is set to the integer value</td></tr>
    <tr><td class="paramname">returnFirst</td><td>if we should go just take the first argument (true) or if we should through the list and pull up the last one (default is false, use true if you want to use the same parameter multiple times)</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if either this argument wasn't there or if the argument was there with a valid parameter </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="twoRobotWander_8cpp-example.html#a3">twoRobotWander.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8704f7fd54d22c68256cb36315136a37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentIntegerVar </td>
          <td>(</td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the integer after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<p><b>Java and Python Wrappers:</b> Not available in Java or Python wrapper libraries.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter to the argument is found and is a valid integer then dest is set to the integer value</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
    <tr><td class="paramname">...</td><td>the extra string to feed into the argument for parsing (like printf)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if either this argument wasn't there or if the argument was there with a valid parameter </dd></dl>

</div>
</div>
<a class="anchor" id="a7b3a82b02b077f3c86d7a9e62322946f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentString </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char **&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>returnFirst</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the word/argument after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter to the argument is found then the dest is set to the parameter</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
    <tr><td class="paramname">returnFirst</td><td>if we should go just take the first argument (true) or if we should through the list and pull up the last one (default is false, use true if you want to use the same parameter multiple times)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if either this argument wasn't there or if the argument was there with a valid parameter </dd></dl>

</div>
</div>
<a class="anchor" id="a6d1edcc90fa221ac61233b091cbd2c37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::checkParameterArgumentStringVar </td>
          <td>(</td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>wasReallySet</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char **&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the word/argument after given argument. </p>
<p>This is like checkParameterArgument but lets you fail out if the argument is there but the parameter for it is not.</p>
<p><b>Java and Python Wrappers:</b> Not available in Java or Python wrapper libraries.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">dest</td><td>if the parameter to the argument is found then the dest is set to the parameter</td></tr>
    <tr><td class="paramname">wasReallySet</td><td>the target of this pointer is set to true if <em>argument</em> was found followed by a valid value, and <em>dest</em> was set to the value, or false if <em>argument</em> was not found and <em>dest</em> was not changed.</td></tr>
    <tr><td class="paramname">...</td><td>the extra string to feed into the argument for parsing (like printf)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if either this argument wasn't there or if the argument was there with a valid parameter </dd></dl>

</div>
</div>
<a class="anchor" id="a88450be1f9acdb05fed7a3df47bdaf69"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char * ArArgumentParser::checkParameterArgumentVar </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>argument</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the word/argument after given argument. </p>
<p><b>Java and Python Wrappers:</b> Not available in Java or Python wrapper libraries.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argument</td><td>the string to check for, if the argument is found its pulled from the list of arguments</td></tr>
    <tr><td class="paramname">...</td><td>the extra string to feed into the argument for parsing (like printf)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NULL if the argument wasn't found, the argument after the one given if the argument was found, or a string with the first char as NULL again if the argument after the one given isn't there </dd></dl>

</div>
</div>
<a class="anchor" id="ae6bdff0e8039200dcf4413292639650b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ArArgumentParser::getWasReallySetOnlyTrue </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If we only set wasReallySet to true. </p>
<p>See the description for the class for more information about this. </p>

</div>
</div>
<a class="anchor" id="a501694b62a7f8b0c3cadd84aeafe1b35"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ArArgumentParser::loadDefaultArguments </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>position</em> = <code>1</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Adds args from default files and environmental variables. </p>
<p>Search all locations for argument defaults and parse them.</p>
<p>These locations may be environment variables to read argument varues from, or files to read. </p><dl class="section see"><dt>See also</dt><dd>addDefaultArgumentLocation</dd></dl>
<dl class="section note"><dt>Note</dt><dd>If you use this function your normal argc (passed into main()) will have been modified, and won't reflect reality anymore. You'll have to use <a class="el" href="classArArgumentParser.html#ad3221128461a8f3a84c78ec6e37ce82a" title="Gets how many arguments are left in this parser. ">getArgc()</a> to get the actual original argument count. This is a little wierd but is this way so lots of people don't have to change lots of code. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="actionExample_8cpp-example.html#a13">actionExample.cpp</a>, <a class="el" href="actionGroupExample_8cpp-example.html#a4">actionGroupExample.cpp</a>, <a class="el" href="actsColorFollowingExample_8cpp-example.html#a21">actsColorFollowingExample.cpp</a>, <a class="el" href="auxSerialExample_8cpp-example.html#a10">auxSerialExample.cpp</a>, <a class="el" href="cameraPTZExample_8cpp-example.html#a2">cameraPTZExample.cpp</a>, <a class="el" href="configExample_8cpp-example.html#a14">configExample.cpp</a>, <a class="el" href="customRangeSensorExample_8cpp-example.html#a22">customRangeSensorExample.cpp</a>, <a class="el" href="customRangeSensorExampleRobotTask_8cpp-example.html#a25">customRangeSensorExampleRobotTask.cpp</a>, <a class="el" href="dataLoggerExample_8cpp-example.html#a4">dataLoggerExample.cpp</a>, <a class="el" href="demo_8cpp-example.html#a8">demo.cpp</a>, <a class="el" href="dpptuExample_8cpp-example.html#a21">dpptuExample.cpp</a>, <a class="el" href="gotoActionExample_8cpp-example.html#a2">gotoActionExample.cpp</a>, <a class="el" href="gpsExample_8cpp-example.html#a2">gpsExample.cpp</a>, <a class="el" href="gpsRobotTaskExample_8cpp-example.html#a8">gpsRobotTaskExample.cpp</a>, <a class="el" href="gripperExample_8cpp-example.html#a22">gripperExample.cpp</a>, <a class="el" href="gyroExample_8cpp-example.html#a23">gyroExample.cpp</a>, <a class="el" href="imuExample_8cpp-example.html#a2">imuExample.cpp</a>, <a class="el" href="joydriveActionExample_8cpp-example.html#a12">joydriveActionExample.cpp</a>, <a class="el" href="laserConnect_8cpp-example.html#a3">laserConnect.cpp</a>, <a class="el" href="lasers_8cpp-example.html#a3">lasers.cpp</a>, <a class="el" href="lineFinderExample_8cpp-example.html#a2">lineFinderExample.cpp</a>, <a class="el" href="moduleExample_8cpp-example.html#a11">moduleExample.cpp</a>, <a class="el" href="mtxAnalogIOExample_8cpp-example.html#a2">mtxAnalogIOExample.cpp</a>, <a class="el" href="mtxDigitalIOExample_8cpp-example.html#a2">mtxDigitalIOExample.cpp</a>, <a class="el" href="mtxWheelLights_8cpp-example.html#a2">mtxWheelLights.cpp</a>, <a class="el" href="robotConnectionCallbacks_8cpp-example.html#a11">robotConnectionCallbacks.cpp</a>, <a class="el" href="robotSyncTaskExample_8cpp-example.html#a5">robotSyncTaskExample.cpp</a>, <a class="el" href="seekurPower_8cpp-example.html#a2">seekurPower.cpp</a>, <a class="el" href="simpleConnect_8cpp-example.html#a2">simpleConnect.cpp</a>, <a class="el" href="simpleMotionCommands_8cpp-example.html#a3">simpleMotionCommands.cpp</a>, <a class="el" href="teleopActionsExample_8cpp-example.html#a2">teleopActionsExample.cpp</a>, <a class="el" href="triangleDriveToActionExample_8cpp-example.html#a3">triangleDriveToActionExample.cpp</a>, and <a class="el" href="wander_8cpp-example.html#a2">wander.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a088077c44dafcd8b1a11deb821155f47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ArArgumentParser::setWasReallySetOnlyTrue </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>wasReallySetOnlyTrue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If we should only set wasReallySet to true. </p>
<p>See the description for the class for more information about this. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>ArArgumentParser.h</li>
<li>ArArgumentParser.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArArgumentParser.html">ArArgumentParser</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
